home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Software Vault: The Gold Collection
/
Software Vault - The Gold Collection (American Databankers) (1993).ISO
/
cdr30
/
stogl140.zip
/
SCRNTOGL.API
< prev
next >
Wrap
Text File
|
1993-06-16
|
7KB
|
216 lines
SCRNTOGL API
This file contains a brief outline of the functions supported by SCRNTOGL
and the application programming interface (API) provided by it.
It is recommended that one use function 00h initially to ensure that
SCRNTOGL is installed before continuing with other functions.
The functions here are a superset of the "RJS Software Program/TSR
Interface Specification v1.00". For details of this specification, kindly
contact RJS Software at FidoNet address "5:7101/55.1" or InterNet address
"p1.f55.n7101.z5.fidonet.org".
-------------------------------- FUNCTIONS --------------------------------
Function 0000h - Check if SCRNTOGL is resident
----------------------------------------------
Entry: AX = 0AAAAh
BX = 0000h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident (if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 0001h - RESERVED
-------------------------
Function 0002h - Set SCRNTOGL toggle-key
----------------------------------------
Entry: AX = 0AAAAh
BX = 0002h
CL = key-code for toggle-key (upper byte of scan-code)
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident and toggle-key set
(if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 0003h - Get SCRNTOGL toggle-key
----------------------------------------
Entry: AX = 0AAAAh
BX = 0003h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident and toggle-key returned
(if successful)
0001h if SCRNTOGL is not resident (if successful)
CL = key-code of toggle-key
Function 0004h - Set SCRNTOGL Delay in Minutes
----------------------------------------------
Entry: AX = 0AAAAh
BX = 0004h
CX = new delay in minutes, in range [1..30]
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, invalid CX values are
ignored (if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 0005h - Get SCRNTOGL Delay in Minutes
----------------------------------------------
Entry: AX = 0AAAAh
BX = 0005h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and delay in minutes
returned (if successful)
0001h if SCRNTOGL is not resident (if successful)
CX = delay in minutes, in range [1..30]
Function 0006h - Enable SCRNTOGL
--------------------------------
Entry: AX = 0AAAAh
BX = 0006h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and was disabled
(if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 0007h - Enable SCRNTOGL
---------------------------------
Entry: AX = 0AAAAh
BX = 0007h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and was enabled
(if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 0008h - Get SCRNTOGL enabled/disabled state
----------------------------------------------------
Entry: AX = 0AAAAh
BX = 0008h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and state returned
(if successful)
0001h if SCRNTOGL is not resident (if successful)
CX = 0000h if SCRNTOGL is currently disabled
0001h if SCRNTOGL is currently enabled
Function 0009h - Turn screen on
-------------------------------
Entry: AX = 0AAAAh
BX = 0009h
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and screen turned on
(if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 000Ah - Turn screen off
--------------------------------
Entry: AX = 0AAAAh
BX = 000Ah
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and screen turned off
(if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 000Bh - Set SCRNTOGL Delay in Seconds
----------------------------------------------
Entry: AX = 0AAAAh
BX = 000Bh
CX = new delay in seconds, in range [1..1800]
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, invalid CX values are
ignored (if successful)
0001h if SCRNTOGL is not resident (if successful)
Function 000Ch - Get SCRNTOGL Delay in Seconds
----------------------------------------------
Entry: AX = 0AAAAh
BX = 000Ch
DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
Call: INT 16h
Returns: AX = 5555h if successful call
= 0xxxxh if unsuccessful call
BX = 0000h if SCRNTOGL is resident, and delay in seconds
returned (if successful)
0001h if SCRNTOGL is not resident (if successful)
CX = delay in seconds, in range [1..1800]
NOTE - With all functions, all registers are saved, except if they return a
value.
- If any function is invalid, BX = 00FFh on return.
- Also, functions FF00h through FFFFh are RESERVED functions.
---------------------------------------------------------------------------
Comments and questions about the API are welcome.
Roland Skinner